refactor(presence): Pass arguments as an object to StateFactory.latest/latestMap #24414
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Latest and LatestMap functions to accept a single object argument instead of multiple parameters, consolidating common options under the PresenceStateOptions interface. Key changes include:
- Updating test cases to pass objects with an "initialValue" property.
- Modifying the signature and internal implementation of Latest and LatestMap functions.
- Re-exporting the new interfaces in the package index and API report.
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/framework/presence/src/test/presenceStates.spec.ts | Updated test to use the new object argument for Latest. |
| packages/framework/presence/src/test/latestValueManager.spec.ts | Updated tests to reflect the new Latest signature. |
| packages/framework/presence/src/test/latestMapValueManager.spec.ts | Updated tests to use the new object argument for LatestMap. |
| packages/framework/presence/src/test/eventing.spec.ts | Updated tests in eventing to pass new argument objects. |
| packages/framework/presence/src/test/batching.spec.ts | Adjusted batching tests to use the new signatures. |
| packages/framework/presence/src/latestValueTypes.ts | Added the PresenceStateOptions interface. |
| packages/framework/presence/src/latestValueManager.ts | Modified Latest signature to accept a LatestProps object. |
| packages/framework/presence/src/latestMapValueManager.ts | Modified LatestMap signature to accept a LatestMapProps object. |
| packages/framework/presence/src/index.ts | Re-exported the new types. |
| packages/framework/presence/api-report/presence.alpha.api.md | Updated API report with the new signatures and types. |
| examples/apps/presence-tracker/src/MouseTracker.ts | Updated usage of Latest with the object argument. |
| examples/apps/presence-tracker/src/FocusTracker.ts | Updated usage of Latest with the new object argument. |
github-actions
bot
added
area: examples
tylerbutler
commented
Apr 21, 2025
jason-ha
reviewed
Apr 21, 2025
jason-ha
reviewed
Apr 22, 2025
jason-ha
reviewed
Apr 22, 2025
jason-ha
reviewed
Apr 22, 2025
tylerbutler
changed the title
alexvy86
approved these changes
Apr 22, 2025
|
I was going to resolve the conflicts to help. I staged it locally and was going to use github UI to make the changes, but there are test changes needed too. So, I have them in a branch. Published to https://github.com/microsoft/FluidFramework/tree/presence/obj-args (merge to your branch with fast forward) |
jason-ha
approved these changes
Apr 22, 2025
jason-ha
approved these changes
Apr 22, 2025
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change updates the signatures of the Latest/LatestMap functions to accept an object as the only argument. The arguments have been named to align with other parts of the API (e.g.
local).